全部文档
1.2构造请求
1.2.1请求URI
| 信息 | 详情 |
|---|---|
| URI格式 | {URI-scheme}://{Endpoint}{path-prefix}/{resource-path}?{query-string} |
| {URI-scheme} | 传输请求的协议，本环境值是：https。如与实际不符，请联系管理员 |
| {Endpoint} | 服务器域名或IP和Port，本环境值是：api.iot.cmft.com。如与实际不符，请联系管理员 |
| {path-prefix} | 所有请求路径的统一前缀，本环境值是：/oes。如与实际不符，请联系管理员 |
| {resource-path} | 资源路径，可参考每个接口的详细信息 |
| {query-string} | 请求参数，对应的参数位置是“Query”，例如：pageSize=5¤tPage=1&name=&accessKeyId=gk5d91BPqvBAe3ET |
| URI示例 | https://api.iot.cmft.com/oes/api/v1/products?pageSize=5¤tPage=1&name=&accessKeyId=gk5d91BPqvBAe3ET&signatureNonce=646&signature=SH2GFONut7xJXyDOsamKYMhVF8 |
1.2.2公共参数
参数列表
| Name | 参数位置 | 含义 | Required | Type | 描述 |
|---|---|---|---|---|---|
| accessKeyId | Query | 用户访问服务所用的密钥ID | Yes | string | 在用户AccessKey管理页面创建并获取。每个接口必传，用于标识访问者身份。 |
| signature | Query | 签名结果串 | Yes（在用户AccessKey管理页面关闭签名机制后，不需再传该参数） | string | 它是对其他请求参数，包括URL请求路径参数，Body参数（目前仅支持JSON格式）的一种算法加密之后得到的字符串，用于防止请求参数被拦截修改。如果开启了签名机制，则每个接口必传。具体签名方法参考签名机制。 |
| signatureNonce | Query | 签名随机数 | Yes（在用户AccessKey管理页面关闭签名机制后，不需再传该参数） | int | 一个数字随机数，要求在一个小时内不能重复，防止请求被窃听并进行重放攻击。如果开启了签名机制，则每个接口必传。 |
| platform | Header | 平台类型（3：ECP） | Yes | int | 全局放在header里，所有接口必传。 |
| projectId | Header | 项目ID | Yes | int | 全局放在header里，所有接口必传。 |
| Accept-Language | Header | 接口返回体中msg字段的语言 | No | string | 具体可选值请参考公共能力 |
| pageSize | Query | 分页大小 | No | int | 所有分页接口的分页大小，不能超过50。 |
1.2.3请求示例
这是cURL的请求示例，供参考：
curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/{resource-path}?{query-string}' \
--header 'platform: 3' \
--header 'Accept-Language: zh-CN'
1.2.4Open API SDK
| 语言 | 下载 | 备注 |
|---|---|---|
| Java | oes-openapi-sdk-java-requestUtil.zip | 具体使用方法请参照压缩包里的README.md文件 |